home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / program / gemxx19.zoo / gem++19 / man / gema.man < prev    next >
Text File  |  1993-06-01  |  3KB  |  91 lines
  1.                      GEM++ - C++ LIBRARIES FOR GEM/AES/VDI
  2.  
  3.  
  4.  
  5. NAME
  6.      GEMactivity - an interaction with the user through the GEM interface.
  7.  
  8. DESCRIPTION
  9.      An interaction is defined by a collection of objects - a menu, some
  10.      windows, a desk accessory, a keysink and timer, all of which are
  11.      optional.
  12.  
  13.      Objects add themselves to the activity when they are created
  14.      and deleted.  For example:
  15.  
  16.               GEMactivity myactivity;
  17.               GEMrsc myrsc;
  18.               GEMmenu mymenu(myactivity, myrsc, RSC_INDEX_OF_MENU);
  19.  
  20.      During the interaction, objects are passed relevent GEMevents,
  21.      and they return GEMfeedback.  The interaction continues until
  22.      one of the objects returns a GEMfeedback message indicating that
  23.      the interaction should end - for example, the GEMmenu might
  24.      return EndInteraction when the "Quit" item is selected.
  25.  
  26.      A GEMactivity may only have one menu, one desk accessory and one
  27.      keysink, so declare at most one of each of these object types
  28.      (this should change in the future).
  29.  
  30. CONSTRUCTORS
  31.      GEMactivity()
  32.        Create a GEMactivity containing no objects.
  33.  
  34. METHODS
  35.      void Do()
  36.        Conduct a user interaction until one of the event processing
  37.        objects signals for the interaction to end - see GEMfeedback.
  38.  
  39.      void BeginDo()
  40.      GEMfeedback OneDo()
  41.      GEMfeedback OneDo(int eventmask)
  42.      void EndDo()
  43.        By using these three calls, the interaction can be done in
  44.        a polling manner - useful for adding GEM++ code as a front
  45.        end to a non-event-driven program - such as one that is centred
  46.        around a keyboard which is _read_ by the program rather than
  47.        the user interface driving the program.  The Do() method
  48.        above is equivalent to:
  49.  
  50.             BeginDo();
  51.             while (OneDo()!=EndInteraction) /* continue */;
  52.             EndDo();
  53.  
  54.        The second form - OneDo(int eventmask) allows even greater
  55.        control of event processing by allowing events to be masked
  56.        out.  See GEMevent (and gemfast.h) for eventtype values.
  57.  
  58.      GEMactivity does contain other methods that are used by components
  59.      to register and deregister themselves.  They are not needed by the
  60.      library user.
  61.  
  62. USAGE
  63.      Declare a GEMapplication (always do this once before you use GEM).
  64.      Declare a GEMrsc (you'll usually need one!).
  65.      Declare a GEMactivity.
  66.      Declare component objects that are to be in the activity.
  67.      Do() the activity.
  68.      Exit your program. 
  69.  
  70. SEE ALSO
  71.      GEMmenu, GEMwindow, GEMformwindow, GEMdesktop, GEMdeskaccessory,
  72.      GEMkeysink, GEMtimer.
  73.  
  74. BUGS
  75.      Bugs in GEM++ should be reported to warwick@cs.uq.oz.au
  76.  
  77. AUTHOR
  78.      Warwick Allison, 1993.
  79.      warwick@cs.uq.oz.au
  80.  
  81. COPYING
  82.      This functionality is part of the GEM++ library,
  83.      and is Copyright 1993 by Warwick W. Allison.
  84.  
  85.      GEM++ is free and protected under the GNU Library General Public
  86.      License.
  87.  
  88.      You are free to copy and modify these sources, provided you
  89.      acknowledge the origin by retaining this notice, and adhere to
  90.      the conditions described in the GNU LGPL.
  91.